home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 February: Technology Seed / Mac Tech Seed Feb '97.toast / OpenDoc 1.2b2c1 / OpenDoc / Interfaces / IDL / SUView.idl < prev    next >
Encoding:
Text File  |  1997-01-01  |  3.7 KB  |  165 lines  |  [TEXT/MPS ]
  1. //#    Copyright:    © 1993-1994 by Apple Computer, Inc., all rights reserved.
  2.  
  3. #ifndef _SUVIEW_
  4. #define _SUVIEW_
  5.  
  6. #ifndef _ODOBJECT_
  7. #include "ODObject.idl"
  8. #endif
  9.  
  10. //==============================================================================
  11. // Classes defined in this interface
  12. //==============================================================================
  13.  
  14. interface   ODStorageUnitView;
  15.  
  16. //==============================================================================
  17. // Classes used by this interface
  18. //==============================================================================
  19. interface    ODStorageUnit;
  20. interface   ODStorageUnitCursor;
  21. interface    ODDraft;
  22. interface    ODStorageUnitRefIterator;
  23. interface    ODPart;
  24.  
  25. //==============================================================================
  26. // ODStorageUnitView
  27. //==============================================================================
  28.  
  29. interface ODStorageUnitView :  ODObject
  30. {
  31.  
  32.     ODStorageUnit  GetStorageUnit();
  33.     
  34.     ODStorageUnitCursor  GetCursor();
  35.     
  36.     ODStorageUnitView   Externalize();  
  37.     
  38.     ODStorageUnitView   Internalize();  
  39.     
  40.     ODID GetID();      
  41.     
  42.     ODStorageUnitName GetName();    
  43.     
  44.     void SetName(in ODStorageUnitName name);
  45.     
  46.     ODStorageUnitView  AddProperty(in ODPropertyName propertyName);      
  47.     
  48.     ODStorageUnitView  AddValue(in ODValueType type);
  49.     
  50.     ODStorageUnitView  Remove();
  51.         
  52.     void CloneInto(in ODDraftKey key,
  53.                     in ODStorageUnit destStorageUnit, 
  54.                     in ODID scopeID);
  55.     
  56.     ODPropertyName  GetProperty();
  57.     
  58.     ODValueType  GetType();
  59.     
  60.     void      SetType(in ODValueType valueType);
  61.     
  62.     void      SetOffset(in ODULong offset);
  63.     
  64.     ODULong    GetOffset();
  65.     
  66.     ODULong    GetValue(in ODULong length, out ODByteArray value);
  67.                         
  68.     void      SetValue(in ODByteArray value);
  69.                         
  70.     void      InsertValue(in ODByteArray value);
  71.                             
  72.     void      DeleteValue(in ODULong length);
  73.     
  74.     ODULong    GetSize();
  75.     
  76.     ODBoolean    IsValidStorageUnitRef(in ODStorageUnitRef ref);
  77.     
  78.     void GetStrongStorageUnitRef(in ODStorageUnitID embeddedSUID, out ODStorageUnitRef strongRef);
  79.     
  80.     void GetWeakStorageUnitRef(in ODStorageUnitID embeddedSUID, out ODStorageUnitRef weakRef);
  81.     
  82.     ODBoolean      IsStrongStorageUnitRef(in ODStorageUnitRef ref);
  83.     
  84.     ODBoolean      IsWeakStorageUnitRef(in ODStorageUnitRef ref);
  85.     
  86.     ODStorageUnitView   RemoveStorageUnitRef(in ODStorageUnitRef aRef);
  87.     
  88.     ODStorageUnitID  GetIDFromStorageUnitRef(in ODStorageUnitRef aRef);
  89.     
  90.     ODStorageUnitRefIterator  CreateStorageUnitRefIterator();
  91.     
  92.     ODULong  GetGenerationNumber();
  93.     
  94.     ODULong  IncrementGenerationNumber();
  95.     
  96.     ODBoolean  IsPromiseValue();
  97.     
  98.     void    SetPromiseValue(in ODValueType valueType,
  99.                             in ODULong offset,
  100.                             in ODByteArray value,
  101.                             in ODPart sourcePart);
  102.                             
  103.     ODULong  GetPromiseValue(in ODValueType valueType,
  104.                                 in ODULong offset,
  105.                                 in ODULong length,
  106.                                 out ODByteArray value,
  107.                                 out ODPart sourcePart);
  108.     
  109.     
  110. #ifdef __SOMIDL__
  111.     implementation
  112.     {
  113.         majorversion = 1; minorversion = 0;
  114.           functionprefix = ODStorageUnitView;
  115.         override:
  116.             somUninit,
  117.             Purge;
  118.         releaseorder:
  119.             reserved1,
  120.             reserved2,
  121.             reserved3,
  122.             GetStorageUnit,
  123.             GetCursor,
  124.             Externalize,
  125.             Internalize,
  126.             GetID,
  127.             GetName,
  128.             SetName,
  129.             AddProperty,
  130.             AddValue,
  131.             Remove,
  132.             CloneInto,
  133.             GetProperty,
  134.             GetType,
  135.             SetType,
  136.             SetOffset,
  137.             GetOffset,
  138.             GetValue,
  139.             SetValue,
  140.             InsertValue,
  141.             DeleteValue,
  142.             GetSize,
  143.             IsValidStorageUnitRef,
  144.             GetStrongStorageUnitRef,
  145.             GetWeakStorageUnitRef,
  146.             IsStrongStorageUnitRef,
  147.             IsWeakStorageUnitRef,
  148.             RemoveStorageUnitRef,
  149.             GetIDFromStorageUnitRef,
  150.             CreateStorageUnitRefIterator,
  151.             GetGenerationNumber,
  152.             IncrementGenerationNumber,
  153.             IsPromiseValue,
  154.             SetPromiseValue,
  155.             GetPromiseValue;
  156.             
  157.     
  158.   };
  159.   
  160. #endif
  161. };
  162.  
  163. #endif  // _SUVIEW_
  164.  
  165.